This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/uslab-obsrange
US Realm laboratory result using Range Data Type for numeric results
This profile was published on Mon, Nov 17, 2014 00:00+1100 as a draft by Health Level Seven International (Orders and Observations - US Lab).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Observation.
Summary
Mandatory: 12 elements (+22 nested mandatory elements)
Must-Support: 54 elements
Fixed Value: 6 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from Observation.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | I | 0..* | Observation | US Realm laboratory result using Range Data Type for numeric results obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: Component code SHALL not be same as observation code |
meta | ∑ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: IETF BCP-47 (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
uslab-specimenrejectreason | S | 0..1 | CodeableConcept | Specimen Rejection Reason URL: http://hl7.org/fhir/StructureDefinition/uslab-specimenrejectreason |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/uslab-specimenrejectreason" | |
valueCodeableConcept | S | 1..1 | CodeableConcept | Value of extension Binding: US Laboratory Observation Specimen Rejection Codes (extensible) |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | S ∑ | 0..1 | Coding | Code defined by a terminology system |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | S ∑ | 1..1 | uri | Identity of the terminology system |
version | ∑ | 0..1 | string | Version of the system - if relevant |
code | S ∑ | 1..1 | code | Symbol in syntax defined by the system |
display | S ∑ | 0..1 | string | Representation defined by the system |
userSelected | ∑ | 0..1 | boolean | If this coding was chosen directly by the user |
text | S ∑ | 0..1 | string | Plain text representation of the concept |
uslab-observationkind | S | 1..1 | code | Kind of observation URL: http://hl7.org/fhir/StructureDefinition/uslab-observationkind |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 1..* | Identifier | Unique Id for this particular observation |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?! S∑ | 1..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | ∑ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | S ∑ | 1..1 | uri | The namespace for the identifier Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
value | S ∑ | 1..1 | string | The value that is unique Example: 123456 |
period | ∑ | 0..1 | Period | Time period when id is/was valid for use |
assigner | ∑ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
status | ?! S∑ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
category | 0..1 | CodeableConcept | Classification of type of observation Binding: Observation Category Codes (example) | |
code | S ∑ | 1..1 | CodeableConcept | US Realm Laboratory Test Name Binding: US Laboratory Observation Profile Observation Name Codes (extensible) |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | S ∑ | 1..* | Coding | Code defined by a terminology system |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | S ∑ | 1..1 | uri | Identity of the terminology system |
version | ∑ | 0..1 | string | Version of the system - if relevant |
code | S ∑ | 1..1 | code | Symbol in syntax defined by the system |
display | S ∑ | 0..1 | string | Representation defined by the system |
userSelected | ∑ | 0..1 | boolean | If this coding was chosen directly by the user |
text | S ∑ | 0..1 | string | Display text |
subject | S ∑ | 1..1 | Reference(US Laboratory Patient Profile | US Laboratory Patient Profile) | Who and/or what this is about |
encounter | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | |
effective[x] | S ∑I | 0..1 | dateTime, Period | Clinically relevant time/time-period for observation inv-1: Datetime must be at least to day. |
issued | S ∑I | 0..1 | instant | Date/Time this was made available inv-3: Datetime must be at least to day. |
performer | ∑ | Reference(Practitioner | Organization | Patient | RelatedPerson) | Who is responsible for the observation Slice: Ordered, Open At End, by type@profile | |
performer | S ∑ | 1..1 | Reference(US Laboratory Organization Profile) | Who is responsible for the observation |
value[x] | S ∑ | 0..1 | Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, Period | Quantitative Range test result |
dataAbsentReason | S I | 0..1 | CodeableConcept | Why the result is missing Binding: Observation Value Absent Reason (extensible) |
interpretation | S | 0..1 | CodeableConcept | High, low, normal, etc. Binding: US Laboratory Observation Profile Interpretation Codes (required) |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | S ∑ | 1..* | Coding | Code defined by a terminology system |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | S ∑ | 1..1 | uri | Identity of the terminology system |
version | ∑ | 0..1 | string | Version of the system - if relevant |
code | S ∑ | 1..1 | code | Symbol in syntax defined by the system |
display | ∑ | 0..1 | string | Representation defined by the system |
userSelected | ∑ | 0..1 | boolean | If this coding was chosen directly by the user |
text | ∑ | 0..1 | string | Plain text representation of the concept |
comments | 0..1 | string | Comments about result | |
method | 0..1 | CodeableConcept | How it was done Binding: Observation Methods (example) | |
specimen | S | 0..1 | Reference(US Laboratory Specimen Profile) | Specimen used for this observation |
device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |
referenceRange | S I | 0..1 | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
low | S I | 0..1 | SimpleQuantity | Low Range, if relevant |
extension | 0..* | Extension | Additional Content defined by implementations | |
value | ∑ | 0..1 | decimal | Numerical value (with implicit precision) |
unit | ∑ | 0..1 | string | Unit representation |
system | S ∑I | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
code | S ∑ | 1..1 | code | Coded form of the unit Binding: UCUM Codes (required) |
high | S I | 0..1 | SimpleQuantity | High Range, if relevant |
extension | 0..* | Extension | Additional Content defined by implementations | |
value | ∑ | 0..1 | decimal | Numerical value (with implicit precision) |
unit | ∑ | 0..1 | string | Unit representation |
system | S ∑I | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
code | S ∑ | 1..1 | code | Coded form of the unit Binding: UCUM Codes (required) |
meaning | 0..1 | CodeableConcept | Indicates the meaning/use of this range of this range Binding: Observation Reference Range Meaning Codes (example) | |
age | S | 0..1 | Range | Applicable age range, if relevant |
extension | 0..* | Extension | Additional Content defined by implementations | |
low | S ∑I | 0..1 | SimpleQuantity | Low limit |
extension | 0..* | Extension | Additional Content defined by implementations | |
value | ∑ | 0..1 | decimal | Numerical value (with implicit precision) |
unit | ∑ | 0..1 | string | Unit representation |
system | S ∑I | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
code | S ∑ | 1..1 | code | Coded form of the unit Binding: AgeUnits (required) |
high | S ∑I | 0..1 | SimpleQuantity | High limit |
extension | 0..* | Extension | Additional Content defined by implementations | |
value | ∑ | 0..1 | decimal | Numerical value (with implicit precision) |
unit | ∑ | 0..1 | string | Unit representation |
system | S ∑I | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
code | S ∑ | 1..1 | code | Coded form of the unit Binding: AgeUnits (required) |
text | 0..1 | string | Text based reference range in an observation | |
component | ∑ | 0..* | BackboneElement | Component results |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
code | ∑ I | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINC Codes (example) |
value[x] | ∑ | 0..1 | Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, Period | Actual component result |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the component result is missing Binding: Observation Value Absent Reason (extensible) |
referenceRange | 0..* | See Observation.referenceRange | Provides guide for interpretation of component result | |
Documentation for this format |
todo
This structure is derived from Observation.
Summary
Mandatory: 12 elements (+22 nested mandatory elements)
Must-Support: 54 elements
Fixed Value: 6 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Observation.
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | I | 0..* | Observation | US Realm laboratory result using Range Data Type for numeric results obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: Component code SHALL not be same as observation code |
meta | ∑ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: IETF BCP-47 (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
uslab-specimenrejectreason | S | 0..1 | CodeableConcept | Specimen Rejection Reason URL: http://hl7.org/fhir/StructureDefinition/uslab-specimenrejectreason |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/uslab-specimenrejectreason" | |
valueCodeableConcept | S | 1..1 | CodeableConcept | Value of extension Binding: US Laboratory Observation Specimen Rejection Codes (extensible) |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | S ∑ | 0..1 | Coding | Code defined by a terminology system |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | S ∑ | 1..1 | uri | Identity of the terminology system |
version | ∑ | 0..1 | string | Version of the system - if relevant |
code | S ∑ | 1..1 | code | Symbol in syntax defined by the system |
display | S ∑ | 0..1 | string | Representation defined by the system |
userSelected | ∑ | 0..1 | boolean | If this coding was chosen directly by the user |
text | S ∑ | 0..1 | string | Plain text representation of the concept |
uslab-observationkind | S | 1..1 | code | Kind of observation URL: http://hl7.org/fhir/StructureDefinition/uslab-observationkind |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 1..* | Identifier | Unique Id for this particular observation |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?! S∑ | 1..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | ∑ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | S ∑ | 1..1 | uri | The namespace for the identifier Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
value | S ∑ | 1..1 | string | The value that is unique Example: 123456 |
period | ∑ | 0..1 | Period | Time period when id is/was valid for use |
assigner | ∑ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
status | ?! S∑ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
category | 0..1 | CodeableConcept | Classification of type of observation Binding: Observation Category Codes (example) | |
code | S ∑ | 1..1 | CodeableConcept | US Realm Laboratory Test Name Binding: US Laboratory Observation Profile Observation Name Codes (extensible) |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | S ∑ | 1..* | Coding | Code defined by a terminology system |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | S ∑ | 1..1 | uri | Identity of the terminology system |
version | ∑ | 0..1 | string | Version of the system - if relevant |
code | S ∑ | 1..1 | code | Symbol in syntax defined by the system |
display | S ∑ | 0..1 | string | Representation defined by the system |
userSelected | ∑ | 0..1 | boolean | If this coding was chosen directly by the user |
text | S ∑ | 0..1 | string | Display text |
subject | S ∑ | 1..1 | Reference(US Laboratory Patient Profile | US Laboratory Patient Profile) | Who and/or what this is about |
encounter | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | |
effective[x] | S ∑I | 0..1 | dateTime, Period | Clinically relevant time/time-period for observation inv-1: Datetime must be at least to day. |
issued | S ∑I | 0..1 | instant | Date/Time this was made available inv-3: Datetime must be at least to day. |
performer | ∑ | Reference(Practitioner | Organization | Patient | RelatedPerson) | Who is responsible for the observation Slice: Ordered, Open At End, by type@profile | |
performer | S ∑ | 1..1 | Reference(US Laboratory Organization Profile) | Who is responsible for the observation |
value[x] | S ∑ | 0..1 | Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, Period | Quantitative Range test result |
dataAbsentReason | S I | 0..1 | CodeableConcept | Why the result is missing Binding: Observation Value Absent Reason (extensible) |
interpretation | S | 0..1 | CodeableConcept | High, low, normal, etc. Binding: US Laboratory Observation Profile Interpretation Codes (required) |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | S ∑ | 1..* | Coding | Code defined by a terminology system |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | S ∑ | 1..1 | uri | Identity of the terminology system |
version | ∑ | 0..1 | string | Version of the system - if relevant |
code | S ∑ | 1..1 | code | Symbol in syntax defined by the system |
display | ∑ | 0..1 | string | Representation defined by the system |
userSelected | ∑ | 0..1 | boolean | If this coding was chosen directly by the user |
text | ∑ | 0..1 | string | Plain text representation of the concept |
comments | 0..1 | string | Comments about result | |
method | 0..1 | CodeableConcept | How it was done Binding: Observation Methods (example) | |
specimen | S | 0..1 | Reference(US Laboratory Specimen Profile) | Specimen used for this observation |
device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |
referenceRange | S I | 0..1 | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
low | S I | 0..1 | SimpleQuantity | Low Range, if relevant |
extension | 0..* | Extension | Additional Content defined by implementations | |
value | ∑ | 0..1 | decimal | Numerical value (with implicit precision) |
unit | ∑ | 0..1 | string | Unit representation |
system | S ∑I | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
code | S ∑ | 1..1 | code | Coded form of the unit Binding: UCUM Codes (required) |
high | S I | 0..1 | SimpleQuantity | High Range, if relevant |
extension | 0..* | Extension | Additional Content defined by implementations | |
value | ∑ | 0..1 | decimal | Numerical value (with implicit precision) |
unit | ∑ | 0..1 | string | Unit representation |
system | S ∑I | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
code | S ∑ | 1..1 | code | Coded form of the unit Binding: UCUM Codes (required) |
meaning | 0..1 | CodeableConcept | Indicates the meaning/use of this range of this range Binding: Observation Reference Range Meaning Codes (example) | |
age | S | 0..1 | Range | Applicable age range, if relevant |
extension | 0..* | Extension | Additional Content defined by implementations | |
low | S ∑I | 0..1 | SimpleQuantity | Low limit |
extension | 0..* | Extension | Additional Content defined by implementations | |
value | ∑ | 0..1 | decimal | Numerical value (with implicit precision) |
unit | ∑ | 0..1 | string | Unit representation |
system | S ∑I | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
code | S ∑ | 1..1 | code | Coded form of the unit Binding: AgeUnits (required) |
high | S ∑I | 0..1 | SimpleQuantity | High limit |
extension | 0..* | Extension | Additional Content defined by implementations | |
value | ∑ | 0..1 | decimal | Numerical value (with implicit precision) |
unit | ∑ | 0..1 | string | Unit representation |
system | S ∑I | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
code | S ∑ | 1..1 | code | Coded form of the unit Binding: AgeUnits (required) |
text | 0..1 | string | Text based reference range in an observation | |
component | ∑ | 0..* | BackboneElement | Component results |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
code | ∑ I | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINC Codes (example) |
value[x] | ∑ | 0..1 | Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, Period | Actual component result |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the component result is missing Binding: Observation Value Absent Reason (extensible) |
referenceRange | 0..* | See Observation.referenceRange | Provides guide for interpretation of component result | |
Documentation for this format |
XML Template
JSON Template
todo
Other representations of profile: Schematron
Path | Name | Conformance | ValueSet |
Observation.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
Observation.extension.valueCodeableConcept | US Laboratory Observation Specimen Rejection Codes | extensible | US Laboratory Observation Specimen Rejection Codes |
Observation.identifier.use | IdentifierUse | required | IdentifierUse |
Observation.identifier.type | Identifier Type Codes | extensible | Identifier Type Codes |
Observation.status | ObservationStatus | required | ObservationStatus |
Observation.category | Observation Category Codes | example | Observation Category Codes |
Observation.code | US Laboratory Observation Profile Observation Name Codes | extensible | US Laboratory Observation Profile Observation Name Codes |
Observation.dataAbsentReason | Observation Value Absent Reason | extensible | Observation Value Absent Reason |
Observation.interpretation | US Laboratory Observation Profile Interpretation Codes | required | US Laboratory Observation Profile Interpretation Codes |
Observation.method | Observation Methods | example | Observation Methods |
Observation.referenceRange.low.code | UCUM Codes | required | UCUM Codes |
Observation.referenceRange.high.code | UCUM Codes | required | UCUM Codes |
Observation.referenceRange.meaning | Observation Reference Range Meaning Codes | example | Observation Reference Range Meaning Codes |
Observation.referenceRange.age.low.code | AgeUnits | required | AgeUnits |
Observation.referenceRange.age.high.code | AgeUnits | required | AgeUnits |
Observation.related.type | ObservationRelationshipType | required | ObservationRelationshipType |
Observation.component.code | LOINC Codes | example | LOINC Codes |
Observation.component.dataAbsentReason | Observation Value Absent Reason | extensible | Observation Value Absent Reason |
Id | Path | Details | Requirements |
obs-6 | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present XPath: not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')]))) | |
obs-7 | Observation | Component code SHALL not be same as observation code XPath: not(exists(f:component/f:code)) or count(for $coding in f:code/f:coding return parent::*/f:component/f:code/f:coding[f:code/@value=$coding/f:code/@value and f:system/@value=$coding/f:system/@value])=0 | |
inv-1 | Observation.effective[x] | Datetime must be at least to day. XPath: f:matches(./\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d([+-][0-2]\d:[0-5]\d|Z)/) | |
inv-3 | Observation.issued | Datetime must be at least to day. XPath: f:matches(./\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d([+-][0-2]\d:[0-5]\d|Z)/) | |
obs-3 | Observation.referenceRange | Must have at least a low or a high or text XPath: (exists(f:low) or exists(f:high)or exists(f:text)) |